<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>CompositeMap.MapMutator (Apache Commons Collections 4.0 API)</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="CompositeMap.MapMutator (Apache Commons Collections 4.0 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompositeMap.MapMutator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections4/map/DefaultedMap.html" title="class in org.apache.commons.collections4.map"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections4/map/CompositeMap.MapMutator.html" target="_top">Frames</a></li>
<li><a href="CompositeMap.MapMutator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.collections4.map</div>
<h2 title="Interface CompositeMap.MapMutator" class="title">Interface CompositeMap.MapMutator&lt;K,V&gt;</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></dd>
</dl>
<dl>
<dt>Enclosing class:</dt>
<dd><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="type parameter in CompositeMap">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="type parameter in CompositeMap">V</a>&gt;</dd>
</dl>
<hr>
<br>
<pre>public static interface <span class="strong">CompositeMap.MapMutator&lt;K,V&gt;</span>
extends <a href="http://download.oracle.com/javase/6/docs/api/java/io/Serializable.html?is-external=true" title="class or interface in java.io">Serializable</a></pre>
<div class="block">This interface allows definition for all of the indeterminate
 mutators in a CompositeMap, as well as providing a hook for
 callbacks on key collisions.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html#put(org.apache.commons.collections4.map.CompositeMap, java.util.Map[], K, V)">put</a></strong>(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;map,
   <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;[]&nbsp;composited,
   <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>&nbsp;key,
   <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&nbsp;value)</code>
<div class="block">Called when the CompositeMap.put() method is invoked.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html#putAll(org.apache.commons.collections4.map.CompositeMap, java.util.Map[], java.util.Map)">putAll</a></strong>(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;map,
      <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;[]&nbsp;composited,
      <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;? extends <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,? extends <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;mapToAdd)</code>
<div class="block">Called when the CompositeMap.putAll() method is invoked.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html#resolveCollision(org.apache.commons.collections4.map.CompositeMap, java.util.Map, java.util.Map, java.util.Collection)">resolveCollision</a></strong>(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;composite,
                <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;existing,
                <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;added,
                <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>&gt;&nbsp;intersect)</code>
<div class="block">Called when adding a new Composited Map results in a
 key collision.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="resolveCollision(org.apache.commons.collections4.map.CompositeMap, java.util.Map, java.util.Map, java.util.Collection)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resolveCollision</h4>
<pre>void&nbsp;resolveCollision(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;composite,
                    <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;existing,
                    <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;added,
                    <a href="http://download.oracle.com/javase/6/docs/api/java/util/Collection.html?is-external=true" title="class or interface in java.util">Collection</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>&gt;&nbsp;intersect)</pre>
<div class="block">Called when adding a new Composited Map results in a
 key collision.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>composite</code> - the CompositeMap with the collision</dd><dd><code>existing</code> - the Map already in the composite which contains the
        offending key</dd><dd><code>added</code> - the Map being added</dd><dd><code>intersect</code> - the intersection of the keysets of the existing and added maps</dd></dl>
</li>
</ul>
<a name="put(org.apache.commons.collections4.map.CompositeMap,java.util.Map[],java.lang.Object,java.lang.Object)">
<!--   -->
</a><a name="put(org.apache.commons.collections4.map.CompositeMap, java.util.Map[], K, V)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&nbsp;put(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;map,
    <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;[]&nbsp;composited,
    <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>&nbsp;key,
    <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&nbsp;value)</pre>
<div class="block">Called when the CompositeMap.put() method is invoked.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the CompositeMap which is being modified</dd><dd><code>composited</code> - array of Maps in the CompositeMap being modified</dd><dd><code>key</code> - key with which the specified value is to be associated.</dd><dd><code>value</code> - value to be associated with the specified key.</dd>
<dt><span class="strong">Returns:</span></dt><dd>previous value associated with specified key, or <tt>null</tt>
         if there was no mapping for key.  A <tt>null</tt> return can
         also indicate that the map previously associated <tt>null</tt>
         with the specified key, if the implementation supports
         <tt>null</tt> values.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if not defined</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the class of the specified key or value
            prevents it from being stored in this map.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if some aspect of this key or value
            prevents it from being stored in this map.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - this map does not permit <tt>null</tt>
            keys or values, and the specified key or value is
            <tt>null</tt>.</dd></dl>
</li>
</ul>
<a name="putAll(org.apache.commons.collections4.map.CompositeMap, java.util.Map[], java.util.Map)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>putAll</h4>
<pre>void&nbsp;putAll(<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map">CompositeMap</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;map,
          <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,<a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;[]&nbsp;composited,
          <a href="http://download.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util">Map</a>&lt;? extends <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">K</a>,? extends <a href="../../../../../org/apache/commons/collections4/map/CompositeMap.MapMutator.html" title="type parameter in CompositeMap.MapMutator">V</a>&gt;&nbsp;mapToAdd)</pre>
<div class="block">Called when the CompositeMap.putAll() method is invoked.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>map</code> - the CompositeMap which is being modified</dd><dd><code>composited</code> - array of Maps in the CompositeMap being modified</dd><dd><code>mapToAdd</code> - Mappings to be stored in this CompositeMap</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if not defined</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/ClassCastException.html?is-external=true" title="class or interface in java.lang">ClassCastException</a></code> - if the class of the specified key or value
            prevents it from being stored in this map.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/IllegalArgumentException.html?is-external=true" title="class or interface in java.lang">IllegalArgumentException</a></code> - if some aspect of this key or value
            prevents it from being stored in this map.</dd>
<dd><code><a href="http://download.oracle.com/javase/6/docs/api/java/lang/NullPointerException.html?is-external=true" title="class or interface in java.lang">NullPointerException</a></code> - this map does not permit <tt>null</tt>
            keys or values, and the specified key or value is
            <tt>null</tt>.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CompositeMap.MapMutator.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/collections4/map/CompositeMap.html" title="class in org.apache.commons.collections4.map"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/collections4/map/DefaultedMap.html" title="class in org.apache.commons.collections4.map"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/collections4/map/CompositeMap.MapMutator.html" target="_top">Frames</a></li>
<li><a href="CompositeMap.MapMutator.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2001&#x2013;2013 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
</body>
</html>
